/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.sdk.extensions.gcp.storage;



import com.bff.gaia.unified.sdk.annotations.Internal;

import com.bff.gaia.unified.sdk.io.fs.ResourceId;



/**

 * <b>For internal use only; no backwards compatibility guarantees.</b>

 *

 * <p>Interface for controlling validation of paths.

 */

@Internal

public interface PathValidator {

  /**

   * Validate that a file pattern is conforming.

   *

   * @param filepattern The file pattern to verify.

   */

  void validateInputFilePatternSupported(String filepattern);



  /**

   * Validate that an output file prefix is conforming.

   *

   * @param filePrefix the file prefix to verify.

   */

  void validateOutputFilePrefixSupported(String filePrefix);



  /**

   * Validates that an output path is conforming.

   *

   * @param resourceId the file prefix to verify.

   */

  void validateOutputResourceSupported(ResourceId resourceId);



  /**

   * Validate that a path is a valid path and that the path is accessible.

   *

   * @param path The path to verify.

   * @return The post-validation path.

   */

  String verifyPath(String path);

}